<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <title>
      XRefresh Monitor
  </title>
  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
<style>

</style>
  <script type="text/javascript">
    window.onload = function() {
      settings = {
          tl: { radius: 10 },
          tr: { radius: 10 },
          bl: { radius: 10 },
          br: { radius: 10 },
          antiAlias: true,
          autoPad: true,
          validTags: ["div"]
      }
      var versionBox = new curvyCorners(settings, document.getElementById("version"));
      versionBox.applyCornersToAll();
    }
  </script>
</head>
<body>
<div id="main">

    <h1>XRefresh Monitor</h1>
    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/xrefresh-server"; return false'>
      <p>Get Version</p>
      <a href="http://rubyforge.org/projects/xrefresh-server" class="numbers">0.1.0</a>
    </div>
    <h1>&#x2192; &#8216;xrefresh-server&#8217;</h1>


	<h2>What</h2>


	<p>XRefresh is browser auto-refresh tool for web developers.</p>


	<p>More: <a href="http://xrefresh.com">http://xrefresh.com</a></p>


	<p>This gem is filesystem monitor for <span class="caps">OSX</span> which can talk to XRefresh clients (e.g. <a href="http://addons.mozilla.org/TODO">Firefox browser plugin</a>).</p>


	<h2>Installing</h2>


	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">xrefresh</span><span class="punct">-</span><span class="ident">server</span></pre></p>


	<h2>Run monitoring server</h2>


	<p>After installation xrefresh-server executable should get onto your system path. To start server simply run:
<pre class='syntax'><span class="ident">xrefresh</span><span class="punct">-</span><span class="ident">server</span></pre></p>


	<h2>The config file</h2>


	<p>This is default config file:
<pre class='syntax'>
<span class="comment"># here specify list of paths to monitor</span>
<span class="ident">paths</span><span class="punct">:</span>
  <span class="punct">-</span> <span class="punct">/</span><span class="regex">Users</span><span class="punct">/&lt;</span><span class="ident">your</span><span class="punct">-</span><span class="ident">user</span><span class="punct">-</span><span class="ident">name</span><span class="punct">&gt;</span> <span class="comment"># by default watch user's home directory</span>
<span class="comment"># - /you/may/add/here/some/other/path</span>
<span class="comment"># - /you/may/add/here/some/another/path</span>

<span class="comment"># you can various filters (ruby regexp pattern)</span>
<span class="comment"># every file is split to dir and file part (for example /Users/mick/proj/coolapp and some_file.rb)</span>
<span class="comment">#   both include filters must be satisfied</span>
<span class="comment">#   both exclude filters must not be satisfied</span>
<span class="comment"># empty value means &quot;apply no filtering&quot;</span>
<span class="ident">dir_include</span><span class="punct">:</span>
<span class="ident">dir_exclude</span><span class="punct">:</span> ^<span class="punct">/</span><span class="regex">Users</span><span class="punct">/&lt;</span><span class="ident">your</span><span class="punct">-</span><span class="ident">user</span><span class="punct">-</span><span class="ident">name</span><span class="punct">&gt;/</span><span class="regex">Library|</span><span class="punct">/\.(</span><span class="ident">svn</span><span class="punct">|</span><span class="ident">framework</span><span class="punct">|</span><span class="ident">app</span><span class="punct">|</span><span class="ident">pbproj</span><span class="punct">|</span><span class="ident">pbxproj</span><span class="punct">|</span><span class="ident">xcode</span><span class="punct">(</span><span class="ident">proj</span><span class="punct">)</span><span class="char">?|</span><span class="ident">bundle</span><span class="punct">)/</span>
<span class="ident">file_include</span><span class="punct">:</span>
<span class="ident">file_exclude</span><span class="punct">:</span> ^<span class="punct">(</span><span class="constant">CVS</span><span class="punct">|</span><span class="constant">SCCS</span><span class="punct">|</span><span class="ident">vssver</span><span class="punct">.</span><span class="char">?.</span><span class="ident">scc</span><span class="punct">|\.(</span><span class="ident">cvsignore</span><span class="punct">|</span><span class="ident">svn</span><span class="punct">|</span><span class="constant">DS_Store</span><span class="punct">)|</span><span class="ident">_svn</span><span class="punct">|</span><span class="constant">Thumbs\</span><span class="punct">.</span><span class="ident">db</span><span class="punct">)</span><span class="global">$|~$|^</span><span class="punct">(\.(</span><span class="char">?!</span><span class="ident">htaccess</span><span class="punct">)[^/</span><span class="regex">]*|<span class="escape">\.</span>(tmproj|o|pyc)|svn-commit(<span class="escape">\.</span>[2-9])?<span class="escape">\.</span>tmp)$ # merged TextMate and Netbeans patterns

# xpert settings
host: 127.0.0.1
port: 41258 # known port for clients to connect 
max_connections: 4 # max client connections
debug: false # run in debug mode?
audit: false # audit server activity
defer_time: 0.5 # aggregation time for events
sleep_time: 0.1 # don't hung cpu in main loop<span class="normal">
</span></span></pre></p>


	<p>As you can see, by default monitor watches your home directory excluding all under ~/Library.
You are encouraged to modify paths section to map to your working project directories.</p>


	<p>By default config file is searched first in current directory and then in your home directory.
You may also specify path to config file via&#8212;config parameter.</p>


	<p>When you first run xrefresh-server and there is no config file found, xrefresh-server will ask to create one for you in your home directory.</p>


	<h2>License</h2>


	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>


	<h2>Contact</h2>


	<p>Comments are welcome. Send an email to <a href="mailto:antonin@hildebradn.cz">Antonin Hildebrand</a></p>
    <p class="coda">
      <a href="mailto:antonin@hildebrand.cz">Antonin Hildebrand</a>, 19th June 2008<br>
      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
    </p>
</div>

<!-- insert site tracking codes here, like Google Urchin -->

</body>
</html>
